<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
	<!--[if lt IE 9]>
	<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
    <title>Token_V1 - Pws.Clients.RestLibrary Documentation</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
    <link type="text/css" rel="stylesheet" href="../main.css"/>
    <script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
    <script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
    <script type="text/javascript" src="../js/navigation.js"></script>
    <script type="text/javascript" src="../js/example.js"></script>
  </head>
  <body>
  	<header><h1>Pws.Clients.RestLibrary : API Documentation</h1>
	</header>
<nav id="namespaces">
	<h2 class="fixed">Namespaces</h2>
	<div class="scroll">
		<ul>
			<li>
          <a href="../Pws.Clients.RestLibrary/index.htm">Pws.Clients.RestLibrary</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Aftersales/index.htm">Pws.Clients.RestLibrary.Aftersales</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers/index.htm">Pws.Clients.RestLibrary.Customers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Contacts/index.htm">Pws.Clients.RestLibrary.Customers.Contacts</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Orders/index.htm">Pws.Clients.RestLibrary.Customers.Orders</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Products/index.htm">Pws.Clients.RestLibrary.Customers.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Permissions/index.htm">Pws.Clients.RestLibrary.ECommerce.Permissions</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Users/index.htm" class="current">Pws.Clients.RestLibrary.ECommerce.Users</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Framework/index.htm">Pws.Clients.RestLibrary.Framework</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products/index.htm">Pws.Clients.RestLibrary.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products.Navigation/index.htm">Pws.Clients.RestLibrary.Products.Navigation</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Shared/index.htm">Pws.Clients.RestLibrary.Shared</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Suppliers/index.htm">Pws.Clients.RestLibrary.Suppliers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceEstimator/index.htm">Pws.Clients.RestLibrary.WorksurfaceEstimator</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceJobs/index.htm">Pws.Clients.RestLibrary.WorksurfaceJobs</a>
      </li>
		</ul>
	</div>
</nav><nav id="types">
  <h2 class="fixed">Types in Pws.Clients.RestLibrary.ECommerce.Users</h2>
	<div class="scroll">
		<ul>
				<li>
            <a href="../Pws.Clients.RestLibrary.ECommerce.Users/Password_V1.htm">Password_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm" class="current">Token_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.ECommerce.Users/Upload_V1.htm">Upload_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.ECommerce.Users/User_V1.htm">User_V1</a>
        </li>
		</ul>
	</div>
</nav>
	<article>
    <header>
		<p class="class"><strong>Type</strong> Token_V1</p>
	</header>
	<section>
		<header>
		<p><strong>Namespace</strong> Pws.Clients.RestLibrary.ECommerce.Users</p>
		<p><strong>Interfaces</strong> <a href="../Pws.Clients.RestLibrary/IPwsObjectSerialisable_V1`1.htm">IPwsObjectSerialisable_V1&lt;T&gt;</a></p>
		</header>
    <div class="sub-header">
			<div id="summary">A Token and its information. This represents a set of user credentials, and the operations can be performed by that user.
For example, the Token contains a link to the Primary Customer, so that Customer information can be retrieved. <blockquote class="remarks">
  application/x.pws.ecommerce.users.token-v1 
</blockquote><div class="example">
  <a href="javascript:void(0)">Show Example</a>
  <pre>[Token][UserId]EXAMP001[/UserId][ExpiryTime]2011-01-01 00:00:00[/ExpiryTime][/Token] </pre>
</div>
			</div>
		
		
		
			<h3 class="section">Properties</h3>
			<ul>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#AccountCode">AccountCode</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#ExpiryTime">ExpiryTime</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#GrantedPermissions">GrantedPermissions</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#Links">Links</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#PrimaryCustomer">PrimaryCustomer</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#PrimarySupplier">PrimarySupplier</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#PrimaryUser">PrimaryUser</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#SecondaryCustomers">SecondaryCustomers</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#SecondaryUsers">SecondaryUsers</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#SupplierCode">SupplierCode</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#Token">Token</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#Uploads">Uploads</a></li>
				<li><a href="../Pws.Clients.RestLibrary.ECommerce.Users/Token_V1.htm#UserId">UserId</a></li>
			</ul>
		
	</div>
	
	
	
	<h3 class="section">Public properties</h3>

	<div id="AccountCode" class="method">
		<h4>
			<span title="System.string">string</span> <strong>AccountCode</strong> get; set;
		</h4>
		<div class="content">The customer account code which the UserId is attached to, if any. 

		</div>
	</div>
	<div id="ExpiryTime" class="method">
		<h4>
			<span title="System.DateTime">DateTime</span> <strong>ExpiryTime</strong> get; set;
		</h4>
		<div class="content">Token expiry time. 

		</div>
	</div>
	<div id="GrantedPermissions" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>GrantedPermissions</strong> get; set;
		</h4>
		<div class="content">A link to the permissions list which is granted for this token. <blockquote class="remarks">
  application/x.pws.ecommerce.permissions.permission[] 
</blockquote>

		</div>
	</div>
	<div id="Links" class="method">
		<h4>
			<span title="System.Collections.Generic.List<Link_V1>">List&lt;Link_V1&gt;</span> <strong>Links</strong> get; set;
		</h4>
		<div class="content">A link which will retrieve the object again.
In order to request a new token off the back of an existing one (for instance, to extend the ExpiryTime)
post a new token to the "self" link within this list. 

		</div>
	</div>
	<div id="PrimaryCustomer" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>PrimaryCustomer</strong> get; set;
		</h4>
		<div class="content">A link to the customer account which this token's user is primarily attached to. <blockquote class="remarks">
  application/x.pws.customers.customer 
</blockquote>

		</div>
	</div>
	<div id="PrimarySupplier" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>PrimarySupplier</strong> get; set;
		</h4>
		<div class="content">A link to the supplier account which this token's user is primarily attached to. <blockquote class="remarks">
  application/x.pws.suppliers.supplier 
</blockquote>

		</div>
	</div>
	<div id="PrimaryUser" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>PrimaryUser</strong> get; set;
		</h4>
		<div class="content">A link to the login representing this user. <blockquote class="remarks">
  application/x.pws.ecommerce.users.user 
</blockquote>

		</div>
	</div>
	<div id="SecondaryCustomers" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>SecondaryCustomers</strong> get; set;
		</h4>
		<div class="content">A link to a list of customer accounts which this token's user may also act on behalf of. <blockquote class="remarks">
  application/x.pws.customers.customer[] 
</blockquote>

		</div>
	</div>
	<div id="SecondaryUsers" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>SecondaryUsers</strong> get; set;
		</h4>
		<div class="content">A link to a list of the other logins which this user is permitted to access. <blockquote class="remarks">
  application/x.pws.ecommerce.users.user[] 
</blockquote>

		</div>
	</div>
	<div id="SupplierCode" class="method">
		<h4>
			<span title="System.string">string</span> <strong>SupplierCode</strong> get; set;
		</h4>
		<div class="content">The supplier account code which the UserId is attached to, if any. 

		</div>
	</div>
	<div id="Token" class="method">
		<h4>
			<span title="System.string">string</span> <strong>Token</strong> get; set;
		</h4>
		<div class="content">The token string, which can be passed as the X-PWS-UserToken authentication header. 

		</div>
	</div>
	<div id="Uploads" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>Uploads</strong> get; set;
		</h4>
		<div class="content">A link for Posting uploads, of any Media Type. The returned object is an Upload object with a unique ID. <blockquote class="remarks">
  application/x.pws.ecommerce.users.upload 
</blockquote>

		</div>
	</div>
	<div id="UserId" class="method">
		<h4>
			<span title="System.string">string</span> <strong>UserId</strong> get; set;
		</h4>
		<div class="content">TradeZone user which is represented by the token. <blockquote class="remarks">
  Required. 
</blockquote>
<div class="example">
  <a href="javascript:void(0)">Show Example</a>
  <pre>AUSER001 </pre>
</div>
		</div>
	</div>
	</section>
	</article><footer>
	<span id="version">Built from v1.0.0.0 of Pws.Clients.RestLibrary</span>
	<span id="docu-link">
		Generated by <a href="http://docu.jagregory.com">docu</a>
	</span>
</footer>
  </body>
</html>